Integration Rules

XTRAC lets you send messages to an external system by using XTRAC Event Notification (XEN). The external system can then perform any necessary actions, including calling XTRAC as needed. However, XEN requires programming by the XTRAC team.

Integration rules specify the external service to call. When a work item is received in a queue, XTRAC evaluates the integration rule. If the rule evaluates as true, XTRAC calls the applicable external service. If the call is successful and a response is received, XTRAC retrieves the information from the external service and replaces the values in the applicable work item with data from the external service. XTRAC then transfers the work item to the queue that you specified.

If the call to the external service is not successful or a response is not received, XTRAC uses the exception policy that is associated with the rule to determine how many times to attempt the service call, how many minutes to wait between attempts, whether an email should be sent, the email address of the contact person, and the queue where the work item should be transferred when all delivery attempts have been exhausted.

Before designing the integration rules, you need to define the external service and exception policies.

IMPORTANT: For general XTRAC rule information, see XTRAC Rules.

You can create a default integration rule so that when the trigger event occurs, XTRAC invokes the default integration rule (if no other integration rule applies). See Default Rules

Creating an Integration Rule

Note: To define an integration rule, you need the Create Integration Rule security function as part of the security group that is associated with your entitlement set.

To create an integration rule

1. In Feature Explorer, click Rules > Integration Rules.
2. In the Integration Rule Summary window, from the Node drop-down list box, select the node where you want to define the new rule.

XTRAC displays all of the existing integration rules that are associated with the node.

3. Click New.
4. In the Integration Rule Detail window, in the Description field, type a description for the rule (up to 60 characters).

By default, XTRAC selects the AR After Received event.

5. Build the rule conditions by selecting the fields, criteria, and values.

For details, see Rule Conditions and Building a Rule Condition.

6. Click the Action tab.
7. In the Action tab, from the External Service drop-down list box, select the external service that you want to use.
8. From the Exception Policy drop-down list box, select the exception policy.
9. (Optional) From the On Success Transfer To drop-down list box, select the queue that you want the work item transferred to when the call to the external service is successful.
10. (Optional) In the Change Request ID field, type the ID of the change request (up to 30 characters).
11. (Optional) In the Memo field, type the reason for creating the rule (up to 60 characters).
12. Click Save.

XTRAC saves the rule, numbers it, and appends it to the bottom of the sequence list on the Integration Rule Summary window.

13. Specify the order in which XTRAC executes the rules.

See Ordering Rules.

14. Specify the node and rule association.

See Using Rules Stored at Another Node.

Copyright © 2011-2014 XTRAC, LLC. All rights reserved.